Deploying britt-github-com with    Cloudflare Pages

View logs

📚 Documentation Style Guide

Documentation Style Guide

Project Summary

Project: "Hi. Welcome to brittcrawford.com." — a personal website built with Hugo. The site currently functions as a minimal personal/business-card style site listing links and a short description, with a small set of content collections (projects, cocktails, daresnot). The repository includes a Hugo theme (hugo-coder) and an exampleSite for the theme. Purpose and goals: present personal information, links, and (potentially) expanded content such as projects, posts, recipes (cocktails), and small API-like documentation snippets. Audience: site owner and any future contributors (writers/editors) who will add or maintain content; also visitors consuming the rendered website. Technical details: Hugo static-site generator; content in content/* as Markdown with YAML/TOML front matter; theme lives in themes/hugo-coder; static assets in static/img and static/; layouts customized in layouts/. Content features include a Table of Contents on long pages, front-matter metadata usage, example code blocks, API-like documentation, and tables in Markdown. The site is low-to-medium technical complexity — standard Hugo content authoring and asset management.

Context

Project: Hi. Welcome to brittcrawford.com.
Description: This is my personal website. Right now it just has a business card-like list of links and a non-committal description. I might add more to it in the future.
Publishing System: Hugo

Primary Documentation Goals

Writing Rules

Core Principles

• Be concise - Use the minimum words necessary
• Be practical - Focus on actionable information
• Be example-driven - Show working code for every concept
• Be consistent - Match existing documentation patterns

Tone Guidelines

Default Tone (Technical Users)

• Direct and practical language
• Assume familiarity with TypeScript, package managers, CLI
• Use technical jargon and shorthand
• Focus on code examples over explanations
• Avoid marketing language or benefit statements

Non-Technical User Adjustments

When explicitly writing for non-technical users:

• Explain what each command does and why
• Spell out abbreviations and technical terms
• Provide simpler code examples with explanations
• Include more step-by-step guidance
• Link to additional learning resources

Publishing System Requirements

Hugo-specific publishing requirements and front matter guidance

General rules

• Every content file that should be rendered by Hugo must contain front matter.
• Use consistent front-matter keys and types across content collections.
• Use ISO 8601 for dates (YYYY-MM-DD or full timestamp YYYY-MM-DDTHH:MM:SSZ).
• Use draft: true for in-progress content; set to false before publishing.
• Prefer YAML front matter (---) for human readability unless your project explicitly uses TOML or JSON.

Required metadata fields (minimum for pages used in this repo)

• title (string) — human-readable page title. REQUIRED.
• date (

... (truncated)

View full style guide

Progress:

🔍 Gather Commits ✓
🧠 Determine User Request ✓
🧠 Determine User Request
🗒️ Generate Internal Release Notes ✓
🗒️ Write Documentation ✓
💾 Finalize ✓